home *** CD-ROM | disk | FTP | other *** search
/ User's Choice Windows CD / User's Choice Windows CD (CMS Software)(1993).iso / utility1 / hlpdk40.zip / HLPDK.HDF < prev    next >
Text File  |  1993-04-29  |  27KB  |  755 lines
  1. ;******************************************************************************
  2. ;                                 .linkColor                                  *
  3. ; set link color to lightGreen on blue (lightGreen (10) + 16 * blue (1) )     *
  4. ; and link high color to lightGreen on light gray (10 + 16 * 7)               *
  5. ;******************************************************************************
  6. .linkColor 26
  7. .linkhigh 122
  8.  
  9. ;******************************************************************************
  10. ;                                 .fixedFont                                  *
  11. ; use a fixed font for Windows target ..                                      *
  12. ;******************************************************************************
  13. .fixedFont
  14.  
  15. ;******************************************************************************
  16. ;                                  overview                                   *
  17. ; notice - a .top = .topic = .entry                                           *
  18. ;******************************************************************************
  19. .top overview
  20. .title HLPDK System Overview
  21.  
  22.  ****************************************************************************
  23.  *                                                                          *
  24.  *                                 ISoft D&M                                *
  25.  *                                 POB. 5517                                *
  26.  *                           Coralville IA 52241                            *
  27.  *                                   U.S.A                                  *
  28.  *                                                                          *
  29.  **************************************************************************** 
  30.  
  31. .par
  32. The Help Engine Development Kit is a system that allows you to create 
  33. hyper-text database help systems with topics and hot links, using a simple
  34. text editor and the help compiler. 
  35. .endpar
  36.  
  37. .par
  38. The help databases can be distributed (free of charge) with the HELPENG
  39. help engine display program. 
  40. .endpar
  41.  
  42. .par
  43. If you own the Paradox Engine you can use the help databases with your
  44. own programs. 
  45. .endpar
  46.  
  47. .par
  48. The helpC compiler that is part of this development kit includes the
  49. ability to create Windows Help source files from the same source the 
  50. dos help sources are created!. Write your help once, and create help
  51. databases for Dos, Windows and DESQview/X !
  52. .endpar
  53.  
  54.         Supported Formats :
  55.  
  56.         Native, Win30, Win31, QuickHelp, THELP, TVHC, POPHELP, DESQview/X
  57.  
  58. .par
  59. Contact ISoft D&M if you want to purchase the WINTEXT UI library for 
  60. Turbo Pascal programs, and use the help engine window in your pascal
  61. programs.
  62. .endpar
  63.  
  64. Related Topics :
  65. ~Registration~register~
  66. ~Contact~contact~
  67. ~File List~fileList~
  68. ~Credits~credits~
  69. ~Help Engine~helpeng~
  70. ~Help Compiler~helpC~
  71. ~Quick Start~quickStart~
  72.  
  73. .endtop
  74.  
  75. ;******************************************************************************
  76. ;                                  register                                   *
  77. ;******************************************************************************
  78. .entry register
  79. .title Registration
  80.  
  81. .par
  82. The Help Engine Development Kit (HLPDK) is a shareware product, 
  83. if you find this product valuable, please register it. 
  84. This section describes the reasons you should register.
  85. .endpar
  86.  
  87. .par
  88. By registering you will receive a complete discussion
  89. of the help engine features, and many examples of usage. You will receive a 
  90. diskette with the latest HLPDK version, and DPMI (dos protected mode)
  91. versions of the help compiler and engine!.
  92. .endpar
  93.  
  94. .par
  95. Your registration will help us to create the next versions of HLPDK, that
  96. will include more options, and features, some of them might even be your
  97. enhancement requests!.
  98. .endpar
  99.  
  100. .par
  101. A point to consider - If you want to create Windows Help source files,
  102. you will have to purchase a word processor that can output RTF files,
  103. the WORD for Windows 2.0 package, for example, is listed at around $500!.
  104. .endpar
  105.  
  106. Related Topics :
  107. ~Contact~contact~
  108. ~Overview~overview~
  109. .end-entry
  110.  
  111. ;******************************************************************************
  112. ;                                   Contact                                   *
  113. ;******************************************************************************
  114. .entry Contact
  115.  
  116.   Please contact :
  117.  
  118.   ISoft D&M,  
  119.   P.O.B 5517
  120.   Coralville IA 52241,
  121.   U.S.A
  122.  
  123.   To contact the author directly : 
  124.  
  125.   Contact :     Loewy Ron,
  126.                 9 Haneveem st.
  127.                 Herzeliya, 46465
  128.                 ISRAEL.
  129.  
  130.   e-mail address : CompuServe - 100274,162
  131.  
  132. Related Topics :
  133. ~Regsiteration~register~
  134. ~Overview~overview~
  135. .end-entry
  136.  
  137. ;******************************************************************************
  138. ;                                  fileList                                   *
  139. ;******************************************************************************
  140. .entry fileList
  141. .title HPLDK Distribution File List
  142.  
  143. This package contains the following files :
  144.  
  145.  HELPENG.EXE    - Help Engine.
  146.  HELPC.EXE      - Help Compiler.
  147.  HLPDK.DOC      - This file.
  148.  HELPC.DOC      - Help Compiler documentation
  149.  HELPDEMO.HDF   - Demo Help Project.
  150.  2NDDEMO.HDF    - Demo Help Project - file 2.
  151.  HELPDEMO.HLP   - Demo Help Project file for Windows WINHELP. 
  152.  HLPDK.REG      - Registration file.
  153.  HLPDK.HDF      - Help Development Kit hypertext help database source.
  154.  HLPDK.HDT      - Help Development Kit help database file.
  155.  HLPDK.SET      - Help Development Kit help database file.
  156.  HLPDKTOP.*     - Help Development Kit help database files.
  157.  HLPDKLNK.*     - Help Development Kit help database files.
  158.  PROGRAMS.TXT   - ISoft D&M shareware products description.
  159.  
  160. Related Topics :
  161. ~Overview~overview~
  162. ~Quick Start~quickStart~
  163. .end-entry
  164.  
  165. ;******************************************************************************
  166. ;                                   Credits                                   *
  167. ;******************************************************************************
  168. .entry Credits
  169.  
  170. .par
  171. HELPENG, HELPC were written using Turbo Pascal 6.0, and Borland Pascal 7.0,
  172. Paradox Engine 2.0, and Paradox Engine 3.0, 3.01. 
  173. (Trademarks of Borland International).
  174. .endpar
  175.  
  176. .par
  177. Windows, Microsoft, HC and Quick Help are trademarks or copyrights
  178. of Microsoft Corp.
  179. .endpar
  180.  
  181. .par
  182. The HELPENG program was written using the WINTEXT UI library, 
  183. (c) 1991,93 Loewy Ron.
  184. .endpar
  185.  
  186. THELP, HL and TVHC are Trademarks or copyrights Borland International.
  187.  
  188. POPHELP is a copyright of TurboPower Software.
  189.  
  190. TVHC support, and other ideas were suggested by MunLeong Chan.
  191.  
  192. .par
  193. Parts of the Help Engine were generated using Ron Loewy's WTGEN CASE code
  194. generator.
  195. .endpar
  196.  
  197. Yaniv Golan helped me with beta-testing and debugging.
  198.  
  199. .par
  200. John Murphy notified me of the paragraph formtting difficulties that
  201. lead to the .PARAGRAPH .END-PARAGRAPH formatting capabilities.
  202. .endpar
  203.  
  204. DESQview/X is a trademark of Quarterdeck Office Systems.
  205.  
  206. .par
  207. MDVXHELP is a copyright (1992) of Daniel J. Bodoh. I have used his
  208. excelent documentation of DESQview/X help format to generate code
  209. to this environment.
  210. .endpar
  211.  
  212. .par
  213. The HC31 problem with characters with ordinal values biggen than 127
  214. was solved thanks to Mr. Lars Fosdal of Norway.
  215. .endpar
  216.  
  217. Related Topics :
  218. ~Overview~overview~
  219. .end-entry
  220.  
  221. ;******************************************************************************
  222. ;                                 quickStart                                  *
  223. ;******************************************************************************
  224. .entry quickStart
  225. .title Quick Start
  226.  
  227. From the command line enter HELPC HELPDEMO to compile the demo help database.
  228.  
  229. .par
  230. After the compilation process is ended, enter HELPENG HELPDEMO to browse the
  231. demo help database.
  232. .endpar
  233.  
  234. If you want to compile for windows :
  235.  
  236. from the command line enter HELPC HELPDEMO /W31
  237. and after that HC31 HELPDEMO
  238. (HC31 is the Microsoft Help Compiler)
  239. .par
  240. from windows, open the HELPDEMO.HLP file from the windows help engine.
  241. (Notice - if you do not have the HC help compiler from windows, we have
  242. included a compiled version of HELPDEMO (HELPDEMO.HLP) so you will be
  243. able to feel the quality of the output that can be generated, and decide
  244. if you want to purchase the HC31 program (Included with the SDK, BC++, 
  245. TPW, BP and probably some other packages), or download it from one of the
  246. sites Microsoft had uploaded it to).
  247. .endpar
  248.  
  249. .par
  250. If you use windows 3.0, or want your help file to be compatible with
  251. winHelp 3.0 use :
  252. .endpar
  253.         HELPC /W30 HELPDEMO
  254.         HC HELPDEMO
  255.  
  256. To compile for THELP use : 
  257.         HELPC /TH+ HELPDEMO
  258.         HL -x -e100 -p -i -oHELPDEMO.TPH HELPDEMO.HL
  259.  
  260. To compile for QuickHelp : 
  261.         HELPC /QH+ HELPDEMO
  262.         HELPMAKE -e15 -oHELPDEMO.QH HELPDEMO.SRC
  263.  
  264. To compile for TVHC :
  265.         HELPC /TV+ HELPDEMO
  266.         TVHC HELPDEMO.TXT
  267.  
  268. To compile for POPHELP :
  269.         HELPC /PH+ HELPDEMO
  270.         MAKEHELP /Q HELPDEMO
  271.  
  272. To compile for DESQview/X
  273.         HELPC /XD+ HELPDEMO
  274.         MDVXHELP HELPDEMO.HLP @HELPDEMO.LST
  275.         COPY HELPDEMO.HLP d:\DVX\HELP
  276.  
  277. Related Topics :
  278. ~Overview~overview~
  279. ~File List~filelist~
  280. .end-entry
  281.  
  282. ;******************************************************************************
  283. ;                                   helpeng                                   *
  284. ;******************************************************************************
  285. .entry helpeng
  286. .title The Help Engine
  287.  
  288. .par
  289. To start the help engine program enter HELPENG on the command line, and 
  290. choose the help database you want to view from the list box. Use the Tab key
  291. to cycle between hot-link words, and press Enter to go to that link.
  292. .endpar
  293.  
  294. .par
  295. If you know the name of the SET file of the database you want to activate, you
  296. can enter it on the command line, and the help engine will display it.
  297. .endpar
  298.  
  299. .par
  300. If you have a mouse, you can use it to point at the hi-lighted links, and 
  301. activate them by pressing the left mouse button.
  302. .endpar
  303.  
  304. .par
  305. Press the ALT-T key combination to choose from a list of TOPICS in the 
  306. database, Press ALT-B to go back to the previous displayed TOPIC, Press
  307. ALT-X to exit the help engine.
  308. .endpar
  309.  
  310. The exit command can be given by pressing the right mouse button.
  311.  
  312. .par
  313. To create a new help database please refer to the ~HELPC~helpc~ documentation
  314. file.
  315. .endpar
  316.  
  317. Related Topics :
  318.  
  319. ~Trouble Shooting~Trouble~
  320. ~Overview~overview~
  321. .end-entry
  322.  
  323. ;******************************************************************************
  324. ;                                   Trouble                                   *
  325. ;******************************************************************************
  326. .entry Trouble
  327. .title Trouble Shooting
  328.  
  329. .par
  330. If you receive some kind of an error message while using the help development
  331. kit please refer to this section.
  332. .endpar
  333.  
  334. tableOps: xxxx error message :
  335. .par
  336. This message is generated by the Paradox Engine if an internal error occurs,
  337. if you receive a message that is not understood (e.g. Table is busy), 
  338. please try one of the following :
  339. .endpar
  340.  1. Try running the Help Compiler or the Help Engine with another input and 
  341.     notice if the problem exists, if it does, turn to the next entry,
  342.     otherwise try to see what the difference between the inputs is.
  343.  2. Check your free memory, try to move some TSR's from memory, or use the
  344.     protected mode compiler/engine available with the registered version.
  345.  3. Check if you have loaded dos SHARE program, it is advised to use SHARE
  346.     with programs that use the Paradox Engine. If you receive a table busy
  347.     error, try to see if you have another program that uses the same table 
  348.     in another session (Windows/DESQview etc..).
  349.  4. PANIC - Please contact the distibuter/author for additional help.
  350.  
  351. Microsoft's HC31 help compiler will generate a error in RTF file error :
  352.  
  353.  1. Re-compile using HELPC 4.0+. This should solve the problem, if the problem
  354.     still exists - please try steps 2 and 3, and notify the author. 
  355.  2. Use a binary disk editor to look at the character at the position x - 1
  356.     in the RTF file (where x is the error position reported by HC31).
  357.  3. Try to replace that charqacter from a special PC oem character to a 
  358.     "standard" ascii character (such as *). If the problem still occurs,
  359.     please contact ISoft D&M/The author, otherwise - you probably came 
  360.     accross a character that HC31 can not handle. In that case - try using
  361.     HC300b (the one that generates winHelp 3.0 format), or delete these 
  362.     characters from your source HDF file.
  363.  
  364. Borland's HL help linker will generate a FE02: Out Of Memory error :
  365.  1. Re-compile using HELPC V3.0+, to include ;INDEX directives after the
  366.     screen's definitions.
  367.  
  368.  Borland's HL help linker will complain about undefined context numbers.
  369.  1. You probably have a contents.h file in the current directory, that hl
  370.     tries to use to bind the help topics to Borland's IDE on-line help,
  371.     try renaming this file, and re-compile with HL.
  372.  
  373. .par
  374. We have encountered some users that ran into problems, because they did 
  375. not use the dos SHARE program. We advise that you will always load the 
  376. SHARE program in your AUTOEXEC.BAT file.
  377. .endpar
  378.  
  379. Related Topics :
  380. ~Overview~overview~
  381. ~Help Engine~helpeng~
  382. ~Help Compiler~helpC~
  383. .end-entry
  384.  
  385. ;******************************************************************************
  386. ;                                    helpC                                    *
  387. ;******************************************************************************
  388. .entry helpC
  389. .title Help Compiler
  390. .par
  391. The HELPC help compiler is a dos command line program that receives a 
  392. help definition file (.HDF) and produce a help database. 
  393. .endpar
  394.  
  395.   The helpC command line is :
  396.  
  397.  HELPC source.fil [/Htopic-table-name] [/Llink-table-name] [/Ddata-file-name] 
  398.                   [/R-] [/ST-] [/CS+] [/EP+]
  399.                   [/W+] [/W30] [/W31] [TH+] [/QH+] [/TV+] [/PH+] [/XD+]
  400.  
  401. .par
  402. The output of the compiler is a set data file called source.SET, that
  403. includes the names of the other help database components. 
  404. .endpar
  405.  
  406. .par
  407. Please Notice - if the /W+ /W30 or /W31 switch is defined, the compiler 
  408. will generate a .HPJ and .RTF files that can be used with the Microsoft 
  409. HC (v3.00b) or HC31 help compiler, and output a .HLP windows help file!. 
  410. .endpar
  411.  
  412. .par
  413. By default the help compiler produces a help cross reference report on the 
  414. topics/links used in the database, if the /R- switch is set, no cross-ref
  415. report will be generated, and no database integrity indicators will be
  416. given.
  417. .endpar
  418.  
  419.  
  420. .par
  421. IMPORTANT - Scan the output cross reference report for links defined, that
  422. are not defined as topics!
  423. .endpar
  424.  
  425. .par
  426. Notice - An additional switch is available that instructs the help compiler
  427. to indicate it's parse and code generation progress. Use the /EP+ switch to
  428. see that the helpC compiler is active. Please understand that the compile
  429. process can take a long time, on complex help databases. This switch does
  430. nothing more that ensure to you that the help compiler is alive. 
  431. .endpar
  432.  
  433. .par
  434. The /ST switch defines if the topic name defined in the .TOPIC command
  435. can include embeded spaces. By default this switch is set to /ST- (No
  436. embedded spaces).
  437. .endpar
  438.  
  439. .par
  440. The /CS switch turns Topics and Links case sensativity to ON. Use this
  441. switch with care - Only if you must have a lower/mixed case index in THELP
  442. or POPHELP use this switch. Notice that help databases that compile fine
  443. with case sensativity set to off, might fail to do so in case sensativity
  444. on. By deafult this switch is set to off (-).
  445. .endpar
  446.  
  447. .par
  448. The /XD switch generates code to the MDVXHELP help compiler, available
  449. free in the file DVXHLP10.ZIP on the internet. When this switch is given,
  450. a set of cover and section files is generated, as well as a response
  451. file that should be used to compile the help database.
  452. .endpar
  453.  
  454. Related Topics :
  455. ~Overview~overview~
  456. ~Help Engine~helpeng~
  457. ~Technical Documentation~techdoc~
  458. .end-entry
  459.  
  460. ;******************************************************************************
  461. ;                                   techDoc                                   *
  462. ;******************************************************************************
  463. .entry techDoc
  464. .title Technical Documentation
  465.  
  466. .par
  467. The Help Engine database is a combination of text that is read by the user,
  468. and a Topic and Links database that allows the user to view the topics
  469. he is interested in, using hyper-text methods.
  470. .endpar
  471.  
  472.  
  473.   Each help database is built of 4 file components : 
  474.  
  475.  1. Help Data File    - this file contains the raw text data.
  476.  2. Topic Index File  - a database table that contains the topic names, and
  477.                         the references to the topics in the Data File.
  478.  3. Links Index File  - a database table that contains the list of links 
  479.                         defined for each topic, and positional data.
  480.  4. Set Data File     - a database configuration file that contains the
  481.                         names of the 3 components defined above, and some 
  482.                         additional information.
  483.  
  484. .par
  485. Version 1.x is the bare-bones version that includes only the basic
  486. operations needed from a hyper-text database, this version is implemented
  487. using the Paradox Engine V3.0 to manage the Topic and Link index tables.
  488. .endpar
  489.  
  490. .par
  491. Version 2.x has a new field in the topic table - the title field, help
  492. databases that were compiled with V1.x will not be executed by version
  493. 2.x, they will have to be re-compiled!.
  494. .endpar
  495.  
  496. .par
  497. Version 3.x fields have different length - the databases have to be 
  498. re-compiled.
  499. .endpar
  500.  
  501. .par
  502. The format of the help database is released to the public domain, if
  503. you implement a database viewer on this database structure, I would be
  504. happy to receive a copy ..
  505. .endpar
  506.  
  507. Related Topics :
  508. ~Help Compiler~helpC~
  509. ~Help Engine~HelpEng~
  510. ~Help Definition Format~hdf~
  511. ~Topic Index Format~tif~
  512. ~Links Index Format~lif~
  513. ~Set File Format~sff~
  514.  
  515. .end-entry
  516.  
  517. ;******************************************************************************
  518. ;                                     hdf                                     *
  519. ;******************************************************************************
  520. .entry hdf
  521. .title Help Definition Format
  522.  
  523.   The help definition file format is as follows :
  524.  
  525. | remarks ...
  526. | remarks ...
  527. | 
  528. | .ENTRY topic-name
  529. | [.TITLE optional title for topic]
  530. | topic text and link reference .. 
  531. | topic text and link reference .. 
  532. | topic text and link reference .. 
  533. | topic text and link reference .. 
  534. | .END-ENTRY 
  535. | 
  536. | remarks ...
  537. | 
  538. | 
  539. | .ENTRY topic2-name
  540. | [.PARAGRAPH]
  541. | topic 2 text and link reference .. 
  542. | topic 2 text and link reference .. 
  543. | topic 2 text and link reference .. 
  544. | [.END-PARAGRAPH]
  545. | additional topic2 text ...
  546. | .END-ENTRY 
  547.  
  548.  
  549.   As can be seen - lines between the .ENTRY and .END-ENTRY keywords are
  550.  the lines processed by the help compiler, to create the help database, 
  551.  every other line is considered a remark, and is not parsed or evaluated by
  552.  the help compiler.
  553.  
  554.   The topic text and link reference lines are simple text lines, with
  555.  special link marks.
  556.  
  557.   A sample will provide the details :
  558.  
  559. This is a text help line that includes one ~~link~~link-topic-name~~ in it.
  560.  
  561.   This line will be displayed in the help engine program as :
  562.  
  563. This is a text help line that includes one link in it.
  564.  
  565.   The word "link" will be in a different color then the rest of the line, 
  566.  to indicate that this is a link. If the user hi-lights the link, and
  567.  presses Enter (or points the mouse cursor and clicks), the help engine will
  568.  look for a topic called "link-topic-name", and display it.
  569.  
  570.   Browse the HELPDEMO.HDF file for a demo of a help database definition file.
  571.  
  572.  Notes :
  573.  
  574.  1. The keywords .TOPIC and .END-TOPIC can be used instead of .ENTRY and
  575.   .  .END-ENTRY respectivly.
  576.  
  577.  2. Keywords are NOT case sensitive. (.topic = .TOPIC = .eNTry)
  578.  
  579.  3. The .TITLE keyword is optional. If no title is defined, the topic name
  580.     is used as a title. (just like in v1.x). 
  581.  
  582.  4. If you want the ~~ sign to appear in your help database, use ~~~~ in your
  583.     help source file. (e.g. "This is a ~~~~" will be "This is a ~~" in the final
  584.     help database.).
  585.  
  586.  5. The Optional .PARAGRAPH and .END-PARAGRAPH commands in the help topic text,
  587.     specify the start and the end of a paragraph. This feature is currently 
  588.     supported only for winhelp sources. This feature is important if you 
  589.     want to create long paragraphs that will wrap correctly when a user resizes
  590.     the help window. It is advized ALWAYS to use this feature for paragraphs,
  591.     future versions of the Help Development Kit will allow greater formatting
  592.     control over paragraphs using this mechanism.
  593.  
  594.  6. When a .PARAGRAPH is issued, a .END-PARAGRAPH MUST be specified at the
  595.     end of the paragraph. These commands must appear as the first words in
  596.     a line. The text after the .PARAGRAPH command is NOT part of the text 
  597.     of the help topic.
  598.  
  599. Additional commands include :
  600.  
  601. | .LINKCOLOR and .LINKHIGH - VGA colors of links in normal and high (selected)
  602. states in the native help format.
  603.  
  604. The syntax of these commands is :
  605.  
  606. | .LINKCOLOR x
  607.  
  608. or
  609.  
  610. | .LINKHIGH y
  611.  
  612. Where x and y are the color of the link, which is a combination of the color
  613. of the foreground with the color of the background multiplied by 16.
  614.  
  615. The colors that can be used for both fore and background are :
  616.  
  617.   Black     = 0
  618.   Blue      = 1
  619.   Green     = 2
  620.   Cyan      = 3
  621.   Red       = 4
  622.   Magenta   = 5
  623.   Brown     = 6
  624.   LightGray = 7
  625.  
  626. The colors that can be used only for the foreground are :
  627.  
  628.   DarkGray     = 8
  629.   LightBlue    = 9
  630.   LightGreen   = 10
  631.   LightCyan    = 11
  632.   LightRed     = 12
  633.   LightMagenta = 13
  634.   Yellow       = 14
  635.   White        = 15
  636.  
  637. For example : to set the normal color of a link to light green on blue, use
  638.  
  639. | .LINKCOLOR 26
  640.  
  641. where 26 = 10 + 16 * 1. (10 = light green, 1 = blue).
  642.  
  643. Creating Multiple Source Projects :
  644.  
  645. Use the .INCLUDE commands in the source of your .HDF file, to include an
  646. additional source file.
  647.  
  648. For Example :
  649.  
  650.  .. some stuff 
  651.  
  652. | .include 2ndfile.hdf
  653.  
  654.  .. additional stuff
  655.  
  656. will process 2NDFILE.HDF in the middle of our source file.
  657.  
  658. Please notice - .INCLUDE commands can be nested in your source file,
  659. it is however not recommended to nest them too deep, helpC does not
  660. close the input file when a .INCLUDEd file is processed, in order to
  661. minimize help generation time - there is however, a limit on the number
  662. of open files that can be used by a program - this is a limit set by dos.
  663.  
  664. GUI Font based targets :
  665.  
  666. The .FIXEDFONT command is used to define a non proportional font as the 
  667. default font of the help database. Currently the only targets affected
  668. by this command are windows winHelp v3.x. If you find that your help 
  669. databases are not aligned after they are converted to winHelp format, use 
  670. this command and re-compile. This command has no effect on targets that are 
  671. different from the targets mentioned before.
  672.  
  673. The .PCFONT command is used to define a font that has the standard pc 
  674. character set (Terminal - in windows). If you convert a text based 
  675. database that uses the PC's special characters, use this command to
  676. set the default font. This command has no effect on targets that are 
  677. different from the targets mentioned before.
  678.  
  679. Related Topics :
  680. ~Technical Documentation~TechDoc~
  681.  
  682. .end-entry
  683.  
  684. ;******************************************************************************
  685. ;                                     tif                                     *
  686. ;******************************************************************************
  687. .entry tif
  688. .title Topic Index Format
  689.  
  690.   The topic index table format is as follows :
  691.  
  692.   TOPIC     - 40 charcters string key - this is the topic "name".
  693.   FILENAME  - 38 characters string field - includes the name of the
  694.               help raw data file. (Notice - V1.0 ignores the value of this 
  695.               field, it is here for future expansion).
  696.   START     - longint (long) field that contains the offset from the data file
  697.               start, to the start of the topics text data, in bytes.
  698.   LEN       - integer (int) field that contains the length (in bytes) of the 
  699.               text data of the topic.
  700.   TITLE     - 50 characters string key - the title of the topic.
  701.  
  702. Related Topics :
  703. ~Technical Documentation~TechDoc~
  704. ~Links Index Format~lif~
  705. .end-entry
  706.  
  707. ;******************************************************************************
  708. ;                                     lif                                     *
  709. ;******************************************************************************
  710. .entry lif
  711. .title Links Index Format
  712.  
  713.   The links index table format is as follows :
  714.  
  715.   TOPIC     - 40 characters string key - the name of the topic that 
  716.               has the link.
  717.   SEQ       - integer (int) key - contains the sequential number of 
  718.               the link in the topic. (This way you can assign the links
  719.               order in the topic).
  720.   LINK      - 40 characters string key - the name of the link topic to
  721.               display if the link is chosen.
  722.   LINE      - integer (int) field - the line (from the start of the topic) 
  723.               this link is displayed on.
  724.   COL       - integer (int) field - the column this link is displayed on.
  725.   TXT       - 60 characters string field - the text to display on the line.
  726.  
  727. Related Topics :
  728. ~Technical Documentation~TechDoc~
  729. ~Topic Index Format~tif~
  730. .end-entry
  731.  
  732. ;******************************************************************************
  733. ;                                     sff                                     *
  734. ;******************************************************************************
  735. .entry sff
  736. .title Set File Format
  737.  
  738.   The set file is a text file that contains one entry in each line, using
  739.  the following format :
  740.  
  741. topic-index-table name
  742. links-index-table name
  743. help-raw-data-file name
  744. number-of-topics
  745. length-of-file
  746. version-of-generating-compiler
  747. link-normal-color
  748. link-high-color
  749.  
  750. ~Technical Documentation~TechDoc~
  751. ~Topic Index Format~tif~
  752. ~Links Index Format~lif~
  753. .end-entry
  754.  
  755.